home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Controls / Visual Basic Controls.iso / vbcontrol / edgetext / readme.~~~ < prev    next >
Encoding:
Text File  |  1998-07-04  |  9.7 KB  |  168 lines
  1. Programmer's Edge Universal Textboxes User Document
  2. Copyright 1998, W. David Ewing
  3.  
  4. I wrote the Programmer's Edge boxes for use in database applications using VB 5.0.  They give the 
  5. basic textbox functionality found in VB, then extend that functionality to allow the 
  6. special data formats which I seem to need the most.  This document assumes you have a 
  7. basic understanding of the VB standard text box already, it also assumes that you have
  8. VB version 5.0 with at least service pack 2 loaded on your computer already.
  9.  
  10. To use the control, just put the EDGETEXT.OCX file in your Windows\System directory,
  11. then from a DOS command line type > c:\windows\system\regsvr32 c:\windows\system\EDGETEXT.ocx
  12. This will register the ocx so that it will appear in your Project / Components menu in 
  13. the VB design time environment.  It will be called Programmer's Edge by Dave Ewing.  Just check the
  14. check box in the components menu next to this item, and you will see the tool box icons for
  15. the Programmer's Edge boxes appear in your toolbar.  You are then ready to drag one onto a form, and
  16. try them out.
  17.  
  18. Here are the different types of text boxes available:
  19.  
  20. Standard Edge TextBox:    This text box allows lots of formatting capabilities which 
  21.                 database programmers usually have to write.  In the custom properties
  22.                 page, you can tell the box to just accept numeric input, or maybe tell
  23.                 it to only accept capital letters.  Each of the check boxes in the 
  24.                 custom properties page represent input that a user may make.  Clicking
  25.                 that any particular check box is allowing the user to input that
  26.                 particular key set.
  27.  
  28. Currency Text Box:    This special textbox allows currency input.  It is only in dollars
  29.                 right now.  If I get a good response to the controls, I will 
  30.                 try to include international currency support in the next release.
  31.                 Use the Value property to read and write raw numbers into the box,
  32.                 and use the Text property to read and write actual currency formatted
  33.                 text.
  34.  
  35. Percent Text Box:        A lot of the programs I have written are for financial institutions.
  36.                 I need the percent text box for these applicaions. It works much the 
  37.                 same way as currency.  To read or write raw numbers into the box, use
  38.                 the Value property.  The Text property allows input of formatted text
  39.                 in the form a percentages.  This box does not convert from decimal,
  40.                 for instance, if you put a value of .1 into the Value property, this 
  41.                 means .1% not 10%.
  42.  
  43. Social Security Box:    This box is used for Social Security number input.  It is pretty self
  44.                 explanatory, and doesn't have a lot of fancy formatting.  Just set
  45.                 the social security numbers with dashes into the Text property, or 
  46.                 set the raw numbers into the Value property.  If the Blink On Error 
  47.                 property is set, it will blink if an invalid value is entered.
  48.  
  49. Telephone Box:        This box supports several different Telephone number formats.  It
  50.                 can be set using the Format Mask property to accept 7 digit, 12 digit,
  51.                 16 digit, etc. phone numbers.  Formatted telephone number text
  52.                 may be inputted through the Text property, and raw telephone numbers
  53.                 can be read and written with the Value property.  If an invalid 
  54.                 telephone number is inputted, and the Blink On Error property is set,
  55.                 then the field will blink and the Blink property will be set so
  56.                 that the programmer is notified as well.
  57.  
  58. Date Box:            This box can be set using the Format Mask property so that it can
  59.                 represent Dates, Times or many combinations of both.  I have tried 
  60.                 to include the most popular formats of dates and times.  The text
  61.                 and value properties of this box behave very similarly.  The Blink
  62.                 property of this box is probably more useful than on any other 
  63.                 because of the pecularities of dates and their formats.
  64.  
  65. Zip Box:            This box can be set using the Format Mask property, to allow input
  66.                 of the most popular US Zip Code formats.  It has two additional 
  67.                 properties for handling the zip codes.  In addition to Text and Value.
  68.                 It also has Zip4 and Zip5 properties.  This properties allow raw formatting
  69.                 of the zip code into its two components since many databases store 
  70.                 them in this fashion.
  71.  
  72. When using these controls, it is important to specify the property you want by name.  In
  73. a standard textbox, for instance, Textbox.Text is implied if you just call the Textbox
  74. by name.  Programmer's Edge boxes; however, don't have default properties, so you must specify 
  75. that you want EdgeText.Text or EdgeText.Value.
  76.  
  77. Here are some of the properties which the different Programmer's Edge boxes have:
  78.  
  79. BLINK:        This property allows the programmer to read  and write the blink feature of
  80.             the Programmer's Edge boxes.  For the special purpose boxes such as Currency,Date,
  81.             Telephone,SocialSecurity,Percent and Zip, Blink will be set if a user enters
  82.             an invalid value.  Data Validity may be checked by seeing if the Blink
  83.             property has been set to True.  This may also be done manually in the 
  84.             Programmer's Edge Box so that in the Lost_Focus event, For Instance, the programmer
  85.             could check the user's input, and if it is invalid, Blink could be set
  86.             to True to show the user that their input is invalid.
  87.  
  88. BLINK ON ERROR:    This can be set to false on the special text boxes so that the boxes won't
  89.             blink when invalid data is inputted.  Several of the boxes just will not
  90.             allow the user to input invalid data, but invalid data can still come from
  91.             the database, if it was not monitored well.  So the Text and Value properties
  92.             can trigger Blinking as well.
  93.  
  94. TEXT:          This works the same as on a regular text box.  The biggest differences are
  95.             that the Blink property can be set if invalid data is written.  In currency,
  96.             for instance, putting letters into the Text property would start the box
  97.             Blinking.  Also be aware of zeroes.  If a zero is entered into this field,
  98.             it is assumed to be invalid on many of the boxes.  This is because since it
  99.             is assumed that formatted text is being read and written to this property,
  100.             a blank string value would be the equivalent of zero.
  101.  
  102. VALUE:        This property is read or written using raw numbers. Some examples are, the 
  103.             currency box where $123.00 would be inputted to the Text property, but
  104.             123.00 would be inputted or read from the Value property.  This is the
  105.             same in Social Security, Telephone, Zip and Percent.  The only boxes which
  106.             this property is only somewhat useful are Programmer's Edge, and Date.  Also be aware
  107.             that the Blinking works opposite of the Text property in that if a Zero is
  108.             written to this property, the box assumes the data is ok on most of the boxes,
  109.             but if a blank string is written to the property, it will start the box
  110.             Blinking
  111.  
  112. CHARS:        This property represents the character mask which allows different types
  113.             of user input.  It is only used on the Programmer's Edge box.  Usually you wouldn't
  114.              set this directly because the numbers it uses are a little cryptic.  
  115.             It is much easier to set the check boxes in the custom properties page.
  116.  
  117. CHARTABLE:        This property is only used when the Use Char Table check box on the custom
  118.             property page is checked.  When this checkbox is checked, any character 
  119.             which is put into this field will then be allowed for user entry.
  120.  
  121. MAXCHARS:        This is the maximum number of characters allowed in the text box.  Be aware
  122.             that This is not checked; however, when the values are put in through 
  123.             the Text property or value property of the Programmer's Edge box.  It is assumed
  124.             that the programmer sets this text before putting it into the box.
  125.  
  126. FOCUSSELECT:    This property can be set to true or false.  When set to true, the text in 
  127.             the textbox    will automatically be selected on the Got_Focus event.  This
  128.             is something I always found myself coding for every text box on a form.  
  129.             It sure is a lot nicer to just have the control do it for me.
  130.  
  131. ESCAPECLEAR:    This property can also be set to true or false.  It will allow the user
  132.             to clear the box just by hitting the escape key even if the text in the 
  133.             box is not selected.
  134.  
  135. FORMATMASK:        This property is used on the Date, Telephone and Zip boxes.  It sets the
  136.             mask of the boxes, for instance, on the date box, you can set this to 
  137.             MM/DD/YYYY, MM/DD/YY, HH:MM:SS, etc., on the Telephone box it can be set
  138.             to 999-9999, or 999-999-9999 etc., on the Zip box, it can be set to 
  139.             99999, or 99999-9999 etc.
  140.  
  141. READONLY:        If this property is set to True, no user input will be allowed, but input
  142.             through the Text and Value properties will still be possible.
  143.  
  144.  
  145. The other properties of the boxes are the same properties which are available on the 
  146. standard VB text boxes, and they work in the same manner.  You will notice a few properties
  147. which are missing.  I hope to make these properties available in the next release, if I get
  148. enough interest in the controls.  I enjoyed building the controls, and I will be continuously 
  149. improving them. I know of several other properties I would personally like to see in the 
  150. controls, but sooner or later you have to release what you have, and see if it will help
  151. anyone else.
  152.  
  153. These controls have saved me countless hours desgning and building Database VB apps.  I hope
  154. they save you as much time as they have saved me.  If you have any questions about the controls,
  155. or if you have feature recommendations for the next release, you can E-Mail me at 
  156.  
  157. k4de@hotmail.com
  158.  
  159. I will try to respond as quickly as I can to your messages.  You can find out how to register
  160. the program in the Order info screen, and be sure to read the license.txt file for distribution,
  161. licensing and warranty information.
  162.  
  163. Thanks, 
  164.  
  165. Dave Ewing
  166. PO Box 1352
  167. Holly Springs, NC 27540-1352
  168. E-Mail k4de@mindspring.com